/***************************************************************************
  tag: Peter Soetens  Mon Jan 19 14:11:26 CET 2004  DataObject.hpp

                        DataObject.hpp -  description
                           -------------------
    begin                : Mon January 19 2004
    copyright            : (C) 2004 Peter Soetens
    email                : peter.soetens@mech.kuleuven.ac.be

 ***************************************************************************
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU General Public                   *
 *   License as published by the Free Software Foundation;                 *
 *   version 2 of the License.                                             *
 *                                                                         *
 *   As a special exception, you may use this file as part of a free       *
 *   software library without restriction.  Specifically, if other files   *
 *   instantiate templates or use macros or inline functions from this     *
 *   file, or you compile this file and link it with other files to        *
 *   produce an executable, this file does not by itself cause the         *
 *   resulting executable to be covered by the GNU General Public          *
 *   License.  This exception does not however invalidate any other        *
 *   reasons why the executable file might be covered by the GNU General   *
 *   Public License.                                                       *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU General Public             *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 59 Temple Place,                                    *
 *   Suite 330, Boston, MA  02111-1307  USA                                *
 *                                                                         *
 ***************************************************************************/

#ifndef CORELIB_DATAOBJECT_HPP
#define CORELIB_DATAOBJECT_HPP

#include "../rtt-config.h"

/**
 * @file DataObject.hpp
 * We can't use typedefs since C++ doesn't allow it for
 * templated classes without specifying all the template
 * parameters.
 */
#if defined(OROBLD_OS_NO_ASM)
#include "DataObjectLocked.hpp"
#else
#include "DataObjectLocked.hpp"
#include "DataObjectLockFree.hpp"
#endif

namespace RTT
{ namespace base {

    /**
     * This object represents the default thread-safe data object implementation used
     * by Orocos objects.
     * @ingroup PortBuffers
     */
    template< class T >
    class DataObject
#if defined(OROBLD_OS_NO_ASM)
        : public DataObjectLocked<T>
#else
        : public DataObjectLockFree<T>
#endif
    {
    public:
        /**
         * The type of the data.
         */
        typedef T DataType;
        typedef T value_t;

    public:
        /**
         * Create a data object for holding a user defined struct.
         */
        DataObject( const T& initial_value = T())
#if defined(OROBLD_OS_NO_ASM)
            : DataObjectLocked<T>(initial_value)
#else
            : DataObjectLockFree<T>(initial_value)
#endif
        {}
    };
}}

#endif

